Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs：Add society doc #818

Merged
merged 5 commits into from
Sep 13, 2024
Merged

docs：Add society doc #818

merged 5 commits into from
Sep 13, 2024

Conversation

Asher-hss
Copy link
Collaborator

@Asher-hss Asher-hss commented Aug 12, 2024 •
edited by Wendong-Fan
Loading

Description

Describe your changes in detail.

Motivation and Context

close #772

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Subtask 1
  • Subtask 2
  • Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

@Asher-hss Asher-hss self-assigned this Aug 12, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Aug 12, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Asher-hss Asher-hss changed the title Add society doc docs：Add society doc Aug 12, 2024
@Wendong-Fan Wendong-Fan added the documentation Improvements or additions to documentation label Aug 16, 2024
@Wendong-Fan Wendong-Fan modified the milestones: Sprint 10, Sprint 9 Aug 16, 2024
Wendong-Fan
Wendong-Fan reviewed Aug 16, 2024
View reviewed changes
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Asher-hss !
I added one commit here 6933e48

I feel the Init_chat Function and Step Function part is not necessary, WDY?

@Wendong-Fan Wendong-Fan linked an issue Aug 16, 2024 that may be closed by this pull request
[Feature Request] Documentation for Roleplaying #772
Closed
2 tasks
@Asher-hss
Copy link
Collaborator Author

Thanks @Asher-hss ! I added one commit here 6933e48

I feel the Init_chat Function and Step Function part is not necessary, WDY?

Thanks @Wendong-Fan, I think it depends on how we define this document. If it's intended for simple use, then the sections on the Init_chat function and Step function may not be necessary. However, if you want to make it clearer for users to understand what they need to do during ‘Get Started’, including those sections would be essential.

@Wendong-Fan
Copy link
Member

Wendong-Fan commented Aug 22, 2024 •
edited
Loading

Thanks @Asher-hss ! I added one commit here 6933e48
I feel the Init_chat Function and Step Function part is not necessary, WDY?

Thanks @Wendong-Fan, I think it depends on how we define this document. If it's intended for simple use, then the sections on the Init_chat function and Step function may not be necessary. However, if you want to make it clearer for users to understand what they need to do during ‘Get Started’, including those sections would be essential.

@Asher-hss Init_chat Function and Step Function are not highly related to society part, it's more like a basic guidance about how to set up your chat agent, so I think we can remove this 2 functions as this part would be included in camel/docs/agents/single_agent.md

Wendong-Fan
Wendong-Fan approved these changes Aug 30, 2024
View reviewed changes
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Asher-hss ! I added one more commit here: ef97d3a to remove some parts I think not necessary, please review it and let me know you have any suggestions

@Wendong-Fan Wendong-Fan merged commit b5b6769 into master Sep 13, 2024
5 of 6 checks passed
@Wendong-Fan Wendong-Fan deleted the society-docs branch September 13, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Wendong-Fan Wendong-Fan Wendong-Fan approved these changes

Assignees

@Asher-hss Asher-hss

Labels
documentation Improvements or additions to documentation
Projects
Project Camel
Status: No status
Milestone
Sprint 9
Development

Successfully merging this pull request may close these issues.

[Feature Request] Documentation for Roleplaying
2 participants
@Asher-hss @Wendong-Fan